<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>OrbbecSDK: /root/libobsensor/include/libobsensor/h/Sensor.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="orbbec_icon.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">OrbbecSDK
   &#160;<span id="projectnumber">1.8.3</span>
   </div>
   <div id="projectbrief">OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_8195f5c0d9a800b311ff87242d342361.html">libobsensor</a></li><li class="navelem"><a class="el" href="dir_9fda3634bd985c8b3aac4c1dd5078468.html">h</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Sensor.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="Sensor_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ObTypes_8h.html">ObTypes.h</a>&quot;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<a class="code" href="ObTypes_8h.html#a01cba50d4d558e4c2035f09b698bb10b">ob_sensor_type</a> <a class="code" href="Sensor_8h.html#aa8e63b875425a80e40613262813a517e">ob_sensor_get_type</a>(<a class="code" href="ObTypes_8h.html#a818d3a4166de3a59430e6fd2bdf9eb28">ob_sensor</a> *sensor, <a class="code" href="structob__error.html">ob_error</a> **error);</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<a class="code" href="ObTypes_8h.html#a563dd4686a4630bca388a41919cdb369">ob_stream_profile_list</a> *<a class="code" href="Sensor_8h.html#a773f42bc0c0708b9ece3b0d1d9f4eebb">ob_sensor_get_stream_profile_list</a>(<a class="code" href="ObTypes_8h.html#a818d3a4166de3a59430e6fd2bdf9eb28">ob_sensor</a> *sensor, <a class="code" href="structob__error.html">ob_error</a> **error);</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="keywordtype">void</span> <a class="code" href="Sensor_8h.html#aa8756a59db4382c257c42e590ee49d8f">ob_sensor_start</a>(<a class="code" href="ObTypes_8h.html#a818d3a4166de3a59430e6fd2bdf9eb28">ob_sensor</a> *sensor, <a class="code" href="ObTypes_8h.html#aa7bf7c140d08fad46a2fd2aad2eeb441">ob_stream_profile</a> *profile, <a class="code" href="ObTypes_8h.html#acaf84a344ddfb4886c9aab136ea2ad0e">ob_frame_callback</a> callback, <span class="keywordtype">void</span> *user_data, <a class="code" href="structob__error.html">ob_error</a> **error);</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="keywordtype">void</span> <a class="code" href="Sensor_8h.html#ac97657e063e0023a1fadfa6a78de63cd">ob_sensor_stop</a>(<a class="code" href="ObTypes_8h.html#a818d3a4166de3a59430e6fd2bdf9eb28">ob_sensor</a> *sensor, <a class="code" href="structob__error.html">ob_error</a> **error);</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="keywordtype">void</span> <a class="code" href="Sensor_8h.html#a67a73fb66b231bd944d8f5818df48ae5">ob_sensor_switch_profile</a>(<a class="code" href="ObTypes_8h.html#a818d3a4166de3a59430e6fd2bdf9eb28">ob_sensor</a> *sensor, <a class="code" href="ObTypes_8h.html#aa7bf7c140d08fad46a2fd2aad2eeb441">ob_stream_profile</a> *profile, <a class="code" href="structob__error.html">ob_error</a> **error);</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="keywordtype">void</span> <a class="code" href="Sensor_8h.html#aae775e0dc51ae6f08a9834b53a48cee2">ob_delete_sensor_list</a>(<a class="code" href="ObTypes_8h.html#a56a65d68fac102481c425341bb70a510">ob_sensor_list</a> *sensor_list, <a class="code" href="structob__error.html">ob_error</a> **error);</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;uint32_t <a class="code" href="Sensor_8h.html#a070ec0f952476423f9fd691082370a75">ob_sensor_list_get_sensor_count</a>(<a class="code" href="ObTypes_8h.html#a56a65d68fac102481c425341bb70a510">ob_sensor_list</a> *sensor_list, <a class="code" href="structob__error.html">ob_error</a> **error);</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<a class="code" href="ObTypes_8h.html#a01cba50d4d558e4c2035f09b698bb10b">ob_sensor_type</a> <a class="code" href="Sensor_8h.html#a2e23ff09993d0d9c1d3678df66911c45">ob_sensor_list_get_sensor_type</a>(<a class="code" href="ObTypes_8h.html#a56a65d68fac102481c425341bb70a510">ob_sensor_list</a> *sensor_list, uint32_t index, <a class="code" href="structob__error.html">ob_error</a> **error);</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<a class="code" href="ObTypes_8h.html#a818d3a4166de3a59430e6fd2bdf9eb28">ob_sensor</a> *<a class="code" href="Sensor_8h.html#ad00a111716ba34864e1abb85aec40493">ob_sensor_list_get_sensor_by_type</a>(<a class="code" href="ObTypes_8h.html#a56a65d68fac102481c425341bb70a510">ob_sensor_list</a> *sensor_list, <a class="code" href="ObTypes_8h.html#a01cba50d4d558e4c2035f09b698bb10b">ob_sensor_type</a> sensorType, <a class="code" href="structob__error.html">ob_error</a> **error);</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<a class="code" href="ObTypes_8h.html#a818d3a4166de3a59430e6fd2bdf9eb28">ob_sensor</a> *<a class="code" href="Sensor_8h.html#a13e074475cbbb895117b2c78aaf61ce0">ob_sensor_list_get_sensor</a>(<a class="code" href="ObTypes_8h.html#a56a65d68fac102481c425341bb70a510">ob_sensor_list</a> *sensor_list, uint32_t index, <a class="code" href="structob__error.html">ob_error</a> **error);</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="keywordtype">void</span> <a class="code" href="Sensor_8h.html#a396811d4fa7a910cb1384d37c6820646">ob_delete_sensor</a>(<a class="code" href="ObTypes_8h.html#a818d3a4166de3a59430e6fd2bdf9eb28">ob_sensor</a> *sensor, <a class="code" href="structob__error.html">ob_error</a> **error);</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;}</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="ObTypes_8h_html_a563dd4686a4630bca388a41919cdb369"><div class="ttname"><a href="ObTypes_8h.html#a563dd4686a4630bca388a41919cdb369">ob_stream_profile_list</a></div><div class="ttdeci">struct StreamProfileListImpl ob_stream_profile_list</div><div class="ttdef"><b>Definition:</b> <a href="ObTypes_8h_source.html#l00062">ObTypes.h:62</a></div></div>
<div class="ttc" id="ObTypes_8h_html_a818d3a4166de3a59430e6fd2bdf9eb28"><div class="ttname"><a href="ObTypes_8h.html#a818d3a4166de3a59430e6fd2bdf9eb28">ob_sensor</a></div><div class="ttdeci">struct SensorImpl ob_sensor</div><div class="ttdef"><b>Definition:</b> <a href="ObTypes_8h_source.html#l00059">ObTypes.h:59</a></div></div>
<div class="ttc" id="Sensor_8h_html_a67a73fb66b231bd944d8f5818df48ae5"><div class="ttname"><a href="Sensor_8h.html#a67a73fb66b231bd944d8f5818df48ae5">ob_sensor_switch_profile</a></div><div class="ttdeci">void ob_sensor_switch_profile(ob_sensor *sensor, ob_stream_profile *profile, ob_error **error)</div><div class="ttdoc">Dynamically switch resolutions. </div></div>
<div class="ttc" id="ObTypes_8h_html_a01cba50d4d558e4c2035f09b698bb10b"><div class="ttname"><a href="ObTypes_8h.html#a01cba50d4d558e4c2035f09b698bb10b">ob_sensor_type</a></div><div class="ttdeci">enum OBSensorType ob_sensor_type</div></div>
<div class="ttc" id="Sensor_8h_html_a773f42bc0c0708b9ece3b0d1d9f4eebb"><div class="ttname"><a href="Sensor_8h.html#a773f42bc0c0708b9ece3b0d1d9f4eebb">ob_sensor_get_stream_profile_list</a></div><div class="ttdeci">ob_stream_profile_list * ob_sensor_get_stream_profile_list(ob_sensor *sensor, ob_error **error)</div><div class="ttdoc">Get a list of all supported stream profiles. </div></div>
<div class="ttc" id="ObTypes_8h_html"><div class="ttname"><a href="ObTypes_8h.html">ObTypes.h</a></div><div class="ttdoc">Provide structs commonly used in the SDK, enumerating constant definitions. </div></div>
<div class="ttc" id="Sensor_8h_html_ad00a111716ba34864e1abb85aec40493"><div class="ttname"><a href="Sensor_8h.html#ad00a111716ba34864e1abb85aec40493">ob_sensor_list_get_sensor_by_type</a></div><div class="ttdeci">ob_sensor * ob_sensor_list_get_sensor_by_type(ob_sensor_list *sensor_list, ob_sensor_type sensorType, ob_error **error)</div><div class="ttdoc">Get a sensor by sensor type. </div></div>
<div class="ttc" id="Sensor_8h_html_a396811d4fa7a910cb1384d37c6820646"><div class="ttname"><a href="Sensor_8h.html#a396811d4fa7a910cb1384d37c6820646">ob_delete_sensor</a></div><div class="ttdeci">void ob_delete_sensor(ob_sensor *sensor, ob_error **error)</div><div class="ttdoc">Delete a sensor object. </div></div>
<div class="ttc" id="Sensor_8h_html_aa8756a59db4382c257c42e590ee49d8f"><div class="ttname"><a href="Sensor_8h.html#aa8756a59db4382c257c42e590ee49d8f">ob_sensor_start</a></div><div class="ttdeci">void ob_sensor_start(ob_sensor *sensor, ob_stream_profile *profile, ob_frame_callback callback, void *user_data, ob_error **error)</div><div class="ttdoc">Open the current sensor and set the callback data frame. </div></div>
<div class="ttc" id="Sensor_8h_html_a13e074475cbbb895117b2c78aaf61ce0"><div class="ttname"><a href="Sensor_8h.html#a13e074475cbbb895117b2c78aaf61ce0">ob_sensor_list_get_sensor</a></div><div class="ttdeci">ob_sensor * ob_sensor_list_get_sensor(ob_sensor_list *sensor_list, uint32_t index, ob_error **error)</div><div class="ttdoc">Get a sensor by index number. </div></div>
<div class="ttc" id="ObTypes_8h_html_aa7bf7c140d08fad46a2fd2aad2eeb441"><div class="ttname"><a href="ObTypes_8h.html#aa7bf7c140d08fad46a2fd2aad2eeb441">ob_stream_profile</a></div><div class="ttdeci">struct StreamProfileImpl ob_stream_profile</div><div class="ttdef"><b>Definition:</b> <a href="ObTypes_8h_source.html#l00061">ObTypes.h:61</a></div></div>
<div class="ttc" id="Sensor_8h_html_ac97657e063e0023a1fadfa6a78de63cd"><div class="ttname"><a href="Sensor_8h.html#ac97657e063e0023a1fadfa6a78de63cd">ob_sensor_stop</a></div><div class="ttdeci">void ob_sensor_stop(ob_sensor *sensor, ob_error **error)</div><div class="ttdoc">Stop the sensor stream. </div></div>
<div class="ttc" id="Sensor_8h_html_aae775e0dc51ae6f08a9834b53a48cee2"><div class="ttname"><a href="Sensor_8h.html#aae775e0dc51ae6f08a9834b53a48cee2">ob_delete_sensor_list</a></div><div class="ttdeci">void ob_delete_sensor_list(ob_sensor_list *sensor_list, ob_error **error)</div><div class="ttdoc">Delete a list of sensor objects. </div></div>
<div class="ttc" id="ObTypes_8h_html_a56a65d68fac102481c425341bb70a510"><div class="ttname"><a href="ObTypes_8h.html#a56a65d68fac102481c425341bb70a510">ob_sensor_list</a></div><div class="ttdeci">struct SensorListImpl ob_sensor_list</div><div class="ttdef"><b>Definition:</b> <a href="ObTypes_8h_source.html#l00060">ObTypes.h:60</a></div></div>
<div class="ttc" id="ObTypes_8h_html_acaf84a344ddfb4886c9aab136ea2ad0e"><div class="ttname"><a href="ObTypes_8h.html#acaf84a344ddfb4886c9aab136ea2ad0e">ob_frame_callback</a></div><div class="ttdeci">void(* ob_frame_callback)(ob_frame *frame, void *user_data)</div><div class="ttdoc">Callback for frame. </div><div class="ttdef"><b>Definition:</b> <a href="ObTypes_8h_source.html#l01287">ObTypes.h:1287</a></div></div>
<div class="ttc" id="Sensor_8h_html_a2e23ff09993d0d9c1d3678df66911c45"><div class="ttname"><a href="Sensor_8h.html#a2e23ff09993d0d9c1d3678df66911c45">ob_sensor_list_get_sensor_type</a></div><div class="ttdeci">ob_sensor_type ob_sensor_list_get_sensor_type(ob_sensor_list *sensor_list, uint32_t index, ob_error **error)</div><div class="ttdoc">Get the sensor type. </div></div>
<div class="ttc" id="Sensor_8h_html_a070ec0f952476423f9fd691082370a75"><div class="ttname"><a href="Sensor_8h.html#a070ec0f952476423f9fd691082370a75">ob_sensor_list_get_sensor_count</a></div><div class="ttdeci">uint32_t ob_sensor_list_get_sensor_count(ob_sensor_list *sensor_list, ob_error **error)</div><div class="ttdoc">Get the number of sensors in the sensor list. </div></div>
<div class="ttc" id="Sensor_8h_html_aa8e63b875425a80e40613262813a517e"><div class="ttname"><a href="Sensor_8h.html#aa8e63b875425a80e40613262813a517e">ob_sensor_get_type</a></div><div class="ttdeci">ob_sensor_type ob_sensor_get_type(ob_sensor *sensor, ob_error **error)</div><div class="ttdoc">Get the type of the sensor. </div></div>
<div class="ttc" id="structob__error_html"><div class="ttname"><a href="structob__error.html">ob_error</a></div><div class="ttdoc">The error class exposed by the SDK, users can get detailed error information according to the error...</div><div class="ttdef"><b>Definition:</b> <a href="ObTypes_8h_source.html#l00143">ObTypes.h:143</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Nov 24 2023 10:56:17 for OrbbecSDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
